GET api/properties/{propertyId}/tasks?status[0]={status[0]}&status[1]={status[1]}&name={name}&sort={sort}&page={page}&pageSize={pageSize}

Get all open tasks for a property

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
propertyId

(Required)

integer

Required

status

(Optional)Limits the results by the module status ids. See the GET api/modulestatuses/tasks route to retrieve the tasks statuses.

Collection of integer

None.

name

(Optional)Limits the results by task name.

string

sort

(Optional)The order in which to sort the returned tasks. Defaults to taskid descending. The possible values are: taskid, duedate

string

page

(Optional)The page number of returned records based on the page size

integer

0

pageSize

(Optional)The number of records to return per page

integer

0

Body Parameters

None.

Response Information

Resource Description

Returns all tasks linked to the property

ListWrapperOfTask
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of Task

None.

Response Formats

application/json, text/json

Sample:
{
  "Total": 1,
  "Elements": [
    {
      "TaskId": 1,
      "TaskDetailId": 2,
      "PropertyId": 1,
      "SourceId": 1,
      "CategoryId": 1,
      "ResponsiblePartyId": 1,
      "TaskTypeId": 1,
      "AssignUserId": 1,
      "ModuleStatusId": 1,
      "ModuleProgressCodeId": 1,
      "AssignUtypeId": 1,
      "StartDate": "2025-12-24T05:28:27.2803993-05:00",
      "DueDate": "2025-12-24T05:28:27.2803993-05:00",
      "CompletionDate": "2025-12-24T05:28:27.2803993-05:00",
      "TaskName": "sample string 3",
      "AccountingCode": "sample string 4",
      "RequestedByContactInfo": "sample string 5",
      "SourceInfo": "sample string 6"
    },
    {
      "TaskId": 1,
      "TaskDetailId": 2,
      "PropertyId": 1,
      "SourceId": 1,
      "CategoryId": 1,
      "ResponsiblePartyId": 1,
      "TaskTypeId": 1,
      "AssignUserId": 1,
      "ModuleStatusId": 1,
      "ModuleProgressCodeId": 1,
      "AssignUtypeId": 1,
      "StartDate": "2025-12-24T05:28:27.2803993-05:00",
      "DueDate": "2025-12-24T05:28:27.2803993-05:00",
      "CompletionDate": "2025-12-24T05:28:27.2803993-05:00",
      "TaskName": "sample string 3",
      "AccountingCode": "sample string 4",
      "RequestedByContactInfo": "sample string 5",
      "SourceInfo": "sample string 6"
    }
  ]
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 105: ResourceNotLinkedToUser
    (User is trying to access a resource that belongs to a property not linked to the user., Forbidden)